<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.telemetry.service.resource.telemetry;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.util.Date;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.util.List;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.Map;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    import org.hackystat.dailyprojectdata.client.DailyProjectDataClient;<a name="line.7"></a>
<FONT color="green">008</FONT>    import org.hackystat.sensorbase.client.SensorBaseClient;<a name="line.8"></a>
<FONT color="green">009</FONT>    import org.hackystat.telemetry.analyzer.configuration.TelemetryDefinitionManager;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.hackystat.telemetry.analyzer.configuration.TelemetryDefinitionManagerFactory;<a name="line.10"></a>
<FONT color="green">011</FONT>    import org.hackystat.telemetry.analyzer.configuration.jaxb.TelemetryDefinition;<a name="line.11"></a>
<FONT color="green">012</FONT>    import org.hackystat.telemetry.service.server.Server;<a name="line.12"></a>
<FONT color="green">013</FONT>    import org.hackystat.telemetry.service.server.ServerProperties;<a name="line.13"></a>
<FONT color="green">014</FONT>    import org.restlet.Context;<a name="line.14"></a>
<FONT color="green">015</FONT>    import org.restlet.data.CharacterSet;<a name="line.15"></a>
<FONT color="green">016</FONT>    import org.restlet.data.Language;<a name="line.16"></a>
<FONT color="green">017</FONT>    import org.restlet.data.MediaType;<a name="line.17"></a>
<FONT color="green">018</FONT>    import org.restlet.data.Request;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.restlet.data.Response;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.restlet.data.Status;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.restlet.resource.Representation;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.restlet.resource.Resource;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.restlet.resource.StringRepresentation;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.restlet.resource.Variant;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    import static org.hackystat.telemetry.service.server.Authenticator.AUTHENTICATOR_DPD_CLIENTS_KEY;<a name="line.26"></a>
<FONT color="green">027</FONT>    import static <a name="line.27"></a>
<FONT color="green">028</FONT>    org.hackystat.telemetry.service.server.Authenticator.AUTHENTICATOR_SENSORBASE_CLIENTS_KEY;<a name="line.28"></a>
<FONT color="green">029</FONT>    import static org.hackystat.telemetry.service.server.ServerProperties.DAILYPROJECTDATA_FULLHOST_KEY;<a name="line.29"></a>
<FONT color="green">030</FONT>    import static org.hackystat.telemetry.service.server.ServerProperties.SENSORBASE_FULLHOST_KEY;<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>    /**<a name="line.32"></a>
<FONT color="green">033</FONT>     * An abstract superclass for all Telemetry resources that supplies common <a name="line.33"></a>
<FONT color="green">034</FONT>     * initialization processing. <a name="line.34"></a>
<FONT color="green">035</FONT>     * This includes:<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;ul&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;li&gt; Extracting the authenticated user identifier (when authentication available)<a name="line.37"></a>
<FONT color="green">038</FONT>     * &lt;li&gt; Extracting the URI elements and parameters. <a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;li&gt; Declares that the TEXT/XML representational variant is supported.<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;/ul&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * <a name="line.41"></a>
<FONT color="green">042</FONT>     * @author Philip Johnson<a name="line.42"></a>
<FONT color="green">043</FONT>     *<a name="line.43"></a>
<FONT color="green">044</FONT>     */<a name="line.44"></a>
<FONT color="green">045</FONT>    public abstract class TelemetryResource extends Resource {<a name="line.45"></a>
<FONT color="green">046</FONT>      <a name="line.46"></a>
<FONT color="green">047</FONT>      /** To be retrieved from the URL as the 'email' template parameter, or null. */<a name="line.47"></a>
<FONT color="green">048</FONT>      protected String uriUser = null; <a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>      /** To be retrieved from the URL as the 'project' template parameter, or null. */<a name="line.50"></a>
<FONT color="green">051</FONT>      protected String projectName = null; <a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>      /** To be retrieved from the URL as the 'chart' template parameter, or null. */<a name="line.53"></a>
<FONT color="green">054</FONT>      protected String chart = null; <a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>      /** To be retrieved from the URL as the 'granularity' template parameter, or null. */<a name="line.56"></a>
<FONT color="green">057</FONT>      protected String granularity = null; <a name="line.57"></a>
<FONT color="green">058</FONT>    <a name="line.58"></a>
<FONT color="green">059</FONT>      /** To be retrieved from the URL as the 'start' template parameter, or null. */<a name="line.59"></a>
<FONT color="green">060</FONT>      protected String start = null; <a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>      /** To be retrieved from the URL as the 'end' template parameter, or null. */<a name="line.62"></a>
<FONT color="green">063</FONT>      protected String end = null; <a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>      /** To be retrieved from the URL as the 'params' template parameter, or null. */<a name="line.65"></a>
<FONT color="green">066</FONT>      protected String params = null; <a name="line.66"></a>
<FONT color="green">067</FONT>      <a name="line.67"></a>
<FONT color="green">068</FONT>      /** The authenticated user, retrieved from the ChallengeResponse, or null. */<a name="line.68"></a>
<FONT color="green">069</FONT>      protected String authUser = null;<a name="line.69"></a>
<FONT color="green">070</FONT>      <a name="line.70"></a>
<FONT color="green">071</FONT>      /** This server (telemetry). */<a name="line.71"></a>
<FONT color="green">072</FONT>      protected Server telemetryServer;<a name="line.72"></a>
<FONT color="green">073</FONT>      <a name="line.73"></a>
<FONT color="green">074</FONT>      /** The sensorbase host (for authentication). */<a name="line.74"></a>
<FONT color="green">075</FONT>      protected String sensorBaseHost;<a name="line.75"></a>
<FONT color="green">076</FONT>      <a name="line.76"></a>
<FONT color="green">077</FONT>      /** The dailyprojectdata host (for analysis). */<a name="line.77"></a>
<FONT color="green">078</FONT>      protected String dpdHost;<a name="line.78"></a>
<FONT color="green">079</FONT>      <a name="line.79"></a>
<FONT color="green">080</FONT>      /** The standard error message returned from invalid authentication. */<a name="line.80"></a>
<FONT color="green">081</FONT>      protected String badAuth = "User is not admin and authenticated user does not not match URI user";<a name="line.81"></a>
<FONT color="green">082</FONT>      <a name="line.82"></a>
<FONT color="green">083</FONT>      /** Records the time at which each HTTP request was initiated. */<a name="line.83"></a>
<FONT color="green">084</FONT>      protected long requestStartTime = new Date().getTime();<a name="line.84"></a>
<FONT color="green">085</FONT>     <a name="line.85"></a>
<FONT color="green">086</FONT>      /**<a name="line.86"></a>
<FONT color="green">087</FONT>       * Provides the following representational variants: TEXT_XML.<a name="line.87"></a>
<FONT color="green">088</FONT>       * @param context The context.<a name="line.88"></a>
<FONT color="green">089</FONT>       * @param request The request object.<a name="line.89"></a>
<FONT color="green">090</FONT>       * @param response The response object.<a name="line.90"></a>
<FONT color="green">091</FONT>       */<a name="line.91"></a>
<FONT color="green">092</FONT>      public TelemetryResource(Context context, Request request, Response response) {<a name="line.92"></a>
<FONT color="green">093</FONT>        super(context, request, response);<a name="line.93"></a>
<FONT color="green">094</FONT>        if (request.getChallengeResponse() != null) {<a name="line.94"></a>
<FONT color="green">095</FONT>          this.authUser = request.getChallengeResponse().getIdentifier();<a name="line.95"></a>
<FONT color="green">096</FONT>        }<a name="line.96"></a>
<FONT color="green">097</FONT>        this.telemetryServer = (Server)getContext().getAttributes().get("TelemetryServer");<a name="line.97"></a>
<FONT color="green">098</FONT>        ServerProperties properties = this.telemetryServer.getServerProperties();<a name="line.98"></a>
<FONT color="green">099</FONT>        this.dpdHost = properties.get(DAILYPROJECTDATA_FULLHOST_KEY);<a name="line.99"></a>
<FONT color="green">100</FONT>        this.sensorBaseHost = properties.get(SENSORBASE_FULLHOST_KEY);<a name="line.100"></a>
<FONT color="green">101</FONT>        this.chart = (String) request.getAttributes().get("chart");<a name="line.101"></a>
<FONT color="green">102</FONT>        this.uriUser = (String) request.getAttributes().get("email");<a name="line.102"></a>
<FONT color="green">103</FONT>        this.projectName = (String) request.getAttributes().get("project");<a name="line.103"></a>
<FONT color="green">104</FONT>        this.granularity = (String) request.getAttributes().get("granularity");<a name="line.104"></a>
<FONT color="green">105</FONT>        this.start = (String) request.getAttributes().get("start");<a name="line.105"></a>
<FONT color="green">106</FONT>        this.end = (String) request.getAttributes().get("end");<a name="line.106"></a>
<FONT color="green">107</FONT>        this.params = (String) request.getAttributes().get("params");<a name="line.107"></a>
<FONT color="green">108</FONT>        getVariants().clear(); // copied from BookmarksResource.java, not sure why needed.<a name="line.108"></a>
<FONT color="green">109</FONT>        getVariants().add(new Variant(MediaType.TEXT_XML));<a name="line.109"></a>
<FONT color="green">110</FONT>      }<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>      /**<a name="line.112"></a>
<FONT color="green">113</FONT>       * The Restlet getRepresentation method which must be overridden by all concrete Resources.<a name="line.113"></a>
<FONT color="green">114</FONT>       * @param variant The variant requested.<a name="line.114"></a>
<FONT color="green">115</FONT>       * @return The Representation. <a name="line.115"></a>
<FONT color="green">116</FONT>       */<a name="line.116"></a>
<FONT color="green">117</FONT>      @Override<a name="line.117"></a>
<FONT color="green">118</FONT>      public abstract Representation getRepresentation(Variant variant);<a name="line.118"></a>
<FONT color="green">119</FONT>      <a name="line.119"></a>
<FONT color="green">120</FONT>      /**<a name="line.120"></a>
<FONT color="green">121</FONT>       * Creates and returns a new Restlet StringRepresentation built from xmlData.<a name="line.121"></a>
<FONT color="green">122</FONT>       * The xmlData will be prefixed with a processing instruction indicating UTF-8 and version 1.0.<a name="line.122"></a>
<FONT color="green">123</FONT>       * @param xmlData The xml data as a string. <a name="line.123"></a>
<FONT color="green">124</FONT>       * @return A StringRepresentation of that xmldata. <a name="line.124"></a>
<FONT color="green">125</FONT>       */<a name="line.125"></a>
<FONT color="green">126</FONT>      public StringRepresentation getStringRepresentation(String xmlData) {<a name="line.126"></a>
<FONT color="green">127</FONT>        return new StringRepresentation(xmlData, MediaType.TEXT_XML, Language.ALL, CharacterSet.UTF_8);<a name="line.127"></a>
<FONT color="green">128</FONT>      }<a name="line.128"></a>
<FONT color="green">129</FONT>      <a name="line.129"></a>
<FONT color="green">130</FONT>      /**<a name="line.130"></a>
<FONT color="green">131</FONT>       * Returns a DailyProjectDataClient instance associated with the User in this request. <a name="line.131"></a>
<FONT color="green">132</FONT>       * @return The DailyProjectDataClient instance. <a name="line.132"></a>
<FONT color="green">133</FONT>       */<a name="line.133"></a>
<FONT color="green">134</FONT>      @SuppressWarnings("unchecked")<a name="line.134"></a>
<FONT color="green">135</FONT>      public DailyProjectDataClient getDailyProjectDataClient() {<a name="line.135"></a>
<FONT color="green">136</FONT>        Map&lt;String, DailyProjectDataClient&gt; userClientMap = <a name="line.136"></a>
<FONT color="green">137</FONT>          (Map&lt;String, DailyProjectDataClient&gt;)this.telemetryServer.getContext().getAttributes()<a name="line.137"></a>
<FONT color="green">138</FONT>          .get(AUTHENTICATOR_DPD_CLIENTS_KEY);<a name="line.138"></a>
<FONT color="green">139</FONT>        return userClientMap.get(this.authUser);<a name="line.139"></a>
<FONT color="green">140</FONT>      }<a name="line.140"></a>
<FONT color="green">141</FONT>      <a name="line.141"></a>
<FONT color="green">142</FONT>      /**<a name="line.142"></a>
<FONT color="green">143</FONT>       * Returns a SensorBaseClient instance associated with the User in this request. <a name="line.143"></a>
<FONT color="green">144</FONT>       * @return The SensorBaseClient instance. <a name="line.144"></a>
<FONT color="green">145</FONT>       */<a name="line.145"></a>
<FONT color="green">146</FONT>      @SuppressWarnings("unchecked")<a name="line.146"></a>
<FONT color="green">147</FONT>      public SensorBaseClient getSensorBaseClient() {<a name="line.147"></a>
<FONT color="green">148</FONT>        Map&lt;String, SensorBaseClient&gt; userClientMap = <a name="line.148"></a>
<FONT color="green">149</FONT>          (Map&lt;String, SensorBaseClient&gt;)this.telemetryServer.getContext().getAttributes()<a name="line.149"></a>
<FONT color="green">150</FONT>          .get(AUTHENTICATOR_SENSORBASE_CLIENTS_KEY);<a name="line.150"></a>
<FONT color="green">151</FONT>        return userClientMap.get(this.authUser);<a name="line.151"></a>
<FONT color="green">152</FONT>      }<a name="line.152"></a>
<FONT color="green">153</FONT>      <a name="line.153"></a>
<FONT color="green">154</FONT>      /**<a name="line.154"></a>
<FONT color="green">155</FONT>       * Returns a list of TelemetryDefinition instances corresponding to all definitions in <a name="line.155"></a>
<FONT color="green">156</FONT>       * telemetry.definitions.xml. <a name="line.156"></a>
<FONT color="green">157</FONT>       * @return A List of TelemetryDefinition instances. <a name="line.157"></a>
<FONT color="green">158</FONT>       */<a name="line.158"></a>
<FONT color="green">159</FONT>      public List&lt;TelemetryDefinition&gt; getTelemetryDefinitions() {<a name="line.159"></a>
<FONT color="green">160</FONT>        TelemetryDefinitionManager manager =  <a name="line.160"></a>
<FONT color="green">161</FONT>          TelemetryDefinitionManagerFactory.getGlobalPersistentInstance();<a name="line.161"></a>
<FONT color="green">162</FONT>        return manager.getDefinitions();<a name="line.162"></a>
<FONT color="green">163</FONT>      }<a name="line.163"></a>
<FONT color="green">164</FONT>      <a name="line.164"></a>
<FONT color="green">165</FONT>      /**<a name="line.165"></a>
<FONT color="green">166</FONT>       * Generates a log message indicating the type of request, the elapsed time required, <a name="line.166"></a>
<FONT color="green">167</FONT>       * the user who requested the data, and the day.<a name="line.167"></a>
<FONT color="green">168</FONT>       */<a name="line.168"></a>
<FONT color="green">169</FONT>      protected void logRequest() {<a name="line.169"></a>
<FONT color="green">170</FONT>        long elapsed = new Date().getTime() - requestStartTime;<a name="line.170"></a>
<FONT color="green">171</FONT>        String msg = elapsed + " ms: " + this.chart + " " + uriUser + " " + this.projectName;<a name="line.171"></a>
<FONT color="green">172</FONT>        telemetryServer.getLogger().info(msg);<a name="line.172"></a>
<FONT color="green">173</FONT>      }<a name="line.173"></a>
<FONT color="green">174</FONT>      <a name="line.174"></a>
<FONT color="green">175</FONT>      /**<a name="line.175"></a>
<FONT color="green">176</FONT>       * Generates a log message indicating the command. <a name="line.176"></a>
<FONT color="green">177</FONT>       * @param command The command (typically cache).<a name="line.177"></a>
<FONT color="green">178</FONT>       */<a name="line.178"></a>
<FONT color="green">179</FONT>      protected void logRequest(String command) {<a name="line.179"></a>
<FONT color="green">180</FONT>        long elapsed = new Date().getTime() - requestStartTime;<a name="line.180"></a>
<FONT color="green">181</FONT>        String msg = elapsed + " ms: " + command;<a name="line.181"></a>
<FONT color="green">182</FONT>        telemetryServer.getLogger().info(msg);<a name="line.182"></a>
<FONT color="green">183</FONT>      }<a name="line.183"></a>
<FONT color="green">184</FONT>      <a name="line.184"></a>
<FONT color="green">185</FONT>      /**<a name="line.185"></a>
<FONT color="green">186</FONT>       * Called when an error resulting from an exception is caught during processing. <a name="line.186"></a>
<FONT color="green">187</FONT>       * @param msg A description of the error.<a name="line.187"></a>
<FONT color="green">188</FONT>       * @param e A chained exception.<a name="line.188"></a>
<FONT color="green">189</FONT>       */<a name="line.189"></a>
<FONT color="green">190</FONT>      protected void setStatusError (String msg, Exception e) {<a name="line.190"></a>
<FONT color="green">191</FONT>        String responseMsg = String.format("%s:%n  Request: %s %s%n  Caused by: %s", <a name="line.191"></a>
<FONT color="green">192</FONT>            msg,  <a name="line.192"></a>
<FONT color="green">193</FONT>            this.getRequest().getMethod().getName(),<a name="line.193"></a>
<FONT color="green">194</FONT>            this.getRequest().getResourceRef().toString(),<a name="line.194"></a>
<FONT color="green">195</FONT>            e.getMessage());<a name="line.195"></a>
<FONT color="green">196</FONT>        this.getLogger().info(responseMsg);<a name="line.196"></a>
<FONT color="green">197</FONT>        getResponse().setStatus(Status.CLIENT_ERROR_BAD_REQUEST, responseMsg);<a name="line.197"></a>
<FONT color="green">198</FONT>      }<a name="line.198"></a>
<FONT color="green">199</FONT>      <a name="line.199"></a>
<FONT color="green">200</FONT>      /**<a name="line.200"></a>
<FONT color="green">201</FONT>       * Called when an error occurs during processing. <a name="line.201"></a>
<FONT color="green">202</FONT>       * @param msg A description of the error.<a name="line.202"></a>
<FONT color="green">203</FONT>       */<a name="line.203"></a>
<FONT color="green">204</FONT>      protected void setStatusError (String msg) {<a name="line.204"></a>
<FONT color="green">205</FONT>        String responseMsg = String.format("%s:%n  Request: %s %s", <a name="line.205"></a>
<FONT color="green">206</FONT>            msg,  <a name="line.206"></a>
<FONT color="green">207</FONT>            this.getRequest().getMethod().getName(),<a name="line.207"></a>
<FONT color="green">208</FONT>            this.getRequest().getResourceRef().toString());<a name="line.208"></a>
<FONT color="green">209</FONT>        this.getLogger().info(responseMsg);<a name="line.209"></a>
<FONT color="green">210</FONT>        getResponse().setStatus(Status.CLIENT_ERROR_BAD_REQUEST, responseMsg);<a name="line.210"></a>
<FONT color="green">211</FONT>      }<a name="line.211"></a>
<FONT color="green">212</FONT>      <a name="line.212"></a>
<FONT color="green">213</FONT>      /**<a name="line.213"></a>
<FONT color="green">214</FONT>       * Called when an internal error occurs during processing. <a name="line.214"></a>
<FONT color="green">215</FONT>       * @param msg A description of the error.<a name="line.215"></a>
<FONT color="green">216</FONT>       */<a name="line.216"></a>
<FONT color="green">217</FONT>      protected void setStatusInternalError (String msg) {<a name="line.217"></a>
<FONT color="green">218</FONT>        String responseMsg = String.format("%s:%n  Request: %s %s", <a name="line.218"></a>
<FONT color="green">219</FONT>            msg,  <a name="line.219"></a>
<FONT color="green">220</FONT>            this.getRequest().getMethod().getName(),<a name="line.220"></a>
<FONT color="green">221</FONT>            this.getRequest().getResourceRef().toString());<a name="line.221"></a>
<FONT color="green">222</FONT>        this.getLogger().info(responseMsg);<a name="line.222"></a>
<FONT color="green">223</FONT>        getResponse().setStatus(Status.SERVER_ERROR_INTERNAL, responseMsg);<a name="line.223"></a>
<FONT color="green">224</FONT>      }<a name="line.224"></a>
<FONT color="green">225</FONT>      <a name="line.225"></a>
<FONT color="green">226</FONT>      <a name="line.226"></a>
<FONT color="green">227</FONT>    <a name="line.227"></a>
<FONT color="green">228</FONT>    }<a name="line.228"></a>




























































</PRE>
</BODY>
</HTML>
